fix(deps): update graphql-codegen (major) by renovate[bot] · Pull Request #609 · dotansimha/graphql-code-generator-community

renovate · 2024-02-02T16:30:09Z

ℹ️ Note

This PR body was truncated due to platform limits.

This PR contains the following updates:

Package	Change	Age	Confidence
@graphql-codegen/plugin-helpers (source)	`^3.0.0` → `^6.0.0`
@graphql-codegen/typescript (source)	`^2.8.1` → `^5.0.0`
@graphql-codegen/visitor-plugin-common (source)	`2.13.8` → `6.2.4`

Release Notes

dotansimha/graphql-code-generator (@graphql-codegen/plugin-helpers)

`v6.1.1`

Compare Source

Patch Changes

#10619 cdf5dc5 Thanks @ardatan! - dependencies updates:
- Updated dependency @graphql-tools/utils@^11.0.0 ↗︎ (from ^10.0.0, in dependencies)

`v6.1.0`

Compare Source

Minor Changes

#10510 9e70bcb Thanks @nickmessing! - add importExtension configuration option

`v6.0.0`

Compare Source

Major Changes

#10218 140298a Thanks @eddeee888! - BREAKING CHANGES: Do not generate __isTypeOf for non-implementing types or non-union members
#10218 140298a Thanks @eddeee888! - Remove deprecated option watchConfig
#10218 140298a Thanks @eddeee888! - Ensure Federation Interfaces have __resolveReference if they are resolvable entities

BREAKING CHANGES: Deprecate onlyResolveTypeForInterfaces because majority of use cases cannot implement resolvers in Interfaces.
BREAKING CHANGES: Deprecate generateInternalResolversIfNeeded.__resolveReference because types do not have __resolveReference if they are not Federation entities or are not resolvable. Users should not have to manually set this option. This option was put in to wait for this major version.
#10218 140298a Thanks @eddeee888! - BREAKING CHANGE: Improve Federation Entity's resolvers' parent param type: These types were using reference types inline. This makes it hard to handle mappers. The Parent type now all comes from ParentResolverTypes to make handling mappers and parent types simpler.
#10218 140298a Thanks @eddeee888! - Fix mappers usage with Federation

mappers was previously used as __resolveReference's first param (usually called "reference"). However, this is incorrect because reference interface comes directly from @key and @requires directives. This patch fixes the issue by creating a new FederationTypes type and use it as the base for federation entity types when being used to type entity references.

BREAKING CHANGES: No longer generate UnwrappedObject utility type, as this was used to support the wrong previously generated type.
#10218 140298a Thanks @eddeee888! - Drop Node 18 support

Minor Changes

#10218 140298a Thanks @eddeee888! - Add allowPartialOutputs flag to partially write successful generation to files

Patch Changes

#10218 140298a Thanks @eddeee888! - Update @requires type
#10218 140298a Thanks @eddeee888! - Fix fields or object types marked with @external being wrongly generated

`v5.1.1`

Compare Source

Patch Changes

#10150 e324382 Thanks @ArminWiebigke! - Allow functions to be passed as valid values for UrlSchemaOptions.customFetch. This was already possible, but the type definitions did not reflect that correctly.

`v5.1.0`

Compare Source

Minor Changes

#9989 55a1e9e Thanks @eddeee888! - Add generateInternalResolversIfNeeded option

This option can be used to generate more correct types for internal resolvers. For example, only generate __resolveReference if the federation object has a resolvable @key.

In the future, this option can be extended to support other internal resolvers e.g. __isTypeOf is only generated for implementing types and union members.

`v5.0.4`

Compare Source

Patch Changes

#9961 dfc5310 Thanks @eddeee888! - Update plugin output type to allow option meta field

`v5.0.3`

Compare Source

Patch Changes

#9813 4e69568 Thanks @saihaj! - bumping for a release

`v5.0.2`

Compare Source

Patch Changes

#9811 d8364e045 Thanks @saihaj! - dependencies updates:
- Updated dependency tslib@~2.6.0 ↗︎ (from ~2.5.0, in dependencies)

`v5.0.1`

Compare Source

Patch Changes

#9523 bb1e0e96e Thanks @tnyo43! - add noSilentErrors option to the config type

`v5.0.0`

Compare Source

Major Changes

bb66c2a31 Thanks @n1ru4l! - Require Node.js >= 16. Drop support for Node.js 14

Patch Changes

#9449 4d9ea1a5a Thanks @n1ru4l! - dependencies updates:
- Updated dependency @graphql-tools/utils@^10.0.0 ↗︎ (from ^9.0.0, in dependencies)
#9332 f46803a8c Thanks @eddeee888! - Update GitHub loader TypeScript type and usage docs
#9360 63827fabe Thanks @beerose! - Add handleAsSDL property to UrlSchemaOptions type

`v4.2.0`

Compare Source

Minor Changes

#9151 b7dacb21f Thanks @'./user/schema.mappers#UserMapper',! - Add watchPattern config option for generates sections.

By default, watch mode automatically watches all GraphQL schema and document files. This means when a change is detected, Codegen CLI is run.

A user may want to run Codegen CLI when non-schema and non-document files are changed. Each generates section now has a watchPattern option to allow more file patterns to be added to the list of patterns to watch.

In the example below, mappers are exported from schema.mappers.ts files. We want to re-run Codegen if the content of *.mappers.ts files change because they change the generated types file. To solve this, we can add mapper file patterns to watch using the glob pattern used for schema and document files.
```
// codegen.ts
const config: CodegenConfig = {
  schema: 'src/schema/**/*.graphql',
  generates: {
    'src/schema/types.ts': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        mappers: {

          Book: './book/schema.mappers#BookMapper',
        },
      }
      watchPattern: 'src/schema/**/*.mappers.ts', // Watches mapper files in `watch` mode. Use an array for multiple patterns e.g. `['src/*.pattern1.ts','src/*.pattern2.ts']`
    },
  },
};
```
Then, run Codegen CLI in watch mode:
```
yarn graphql-codegen --watch
```
Now, updating *.mappers.ts files re-runs Codegen! 🎉

Note: watchPattern is only used in watch mode i.e. running CLI with --watch flag.

Patch Changes

f104619ac Thanks @saihaj! - Resolve issue with nesting fields in @provides directive being prevented

`v4.1.0`

Compare Source

Minor Changes

#8893 a118c307a Thanks @n1ru4l! - mark plugins in config optional

#8723 a3309e63e Thanks @kazekyo! - Introduce a new feature called DocumentTransform.

DocumentTransform is a functionality that allows you to modify documents before they are processed by plugins. You can use functions passed to the documentTransforms option to make changes to GraphQL documents.

To use this feature, you can write documentTransforms as follows:

import type { CodegenConfig } from '@&#8203;graphql-codegen/cli'

const config: CodegenConfig = {
  schema: 'https://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      documentTransforms: [
        {
          transform: ({ documents }) => {
            // Make some changes to the documents
            return documents
          }
        }
      ]
    }
  }
}
export default config

For instance, to remove a @localOnlyDirective directive from documents, you can write the following code:

import type { CodegenConfig } from '@&#8203;graphql-codegen/cli'
import { visit } from 'graphql'

const config: CodegenConfig = {
  schema: 'https://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      documentTransforms: [
        {
          transform: ({ documents }) => {
            return documents.map(documentFile => {
              documentFile.document = visit(documentFile.document, {
                Directive: {
                  leave(node) {
                    if (node.name.value === 'localOnlyDirective') return null
                  }
                }
              })
              return documentFile
            })
          }
        }
      ]
    }
  }
}
export default config

DocumentTransform can also be specified by file name. You can create a custom file for a specific transformation and pass it to documentTransforms.

Let's create the document transform as a file:

module.exports = {
  transform: ({ documents }) => {
    // Make some changes to the documents
    return documents
  }
}

Then, you can specify the file name as follows:

import type { CodegenConfig } from '@&#8203;graphql-codegen/cli'

const config: CodegenConfig = {
  schema: 'https://localhost:4000/graphql',
  documents: ['src/**/*.tsx'],
  generates: {
    './src/gql/': {
      preset: 'client',
      documentTransforms: ['./my-document-transform.js']
    }
  }
}
export default config

Patch Changes

#8879 8206b268d Thanks @renovate! - dependencies updates:
- Updated dependency tslib@~2.5.0 ↗︎ (from ~2.4.0, in dependencies)

`v4.0.0`

Compare Source

Major Changes

#8885 fd0b0c813 Thanks @n1ru4l! - drop Node.js 12 support

Patch Changes

#8871 fc79b65d4 Thanks @B2o5T! - eslint fixes

dotansimha/graphql-code-generator (@graphql-codegen/typescript)

Major Changes

#10218 140298a Thanks @eddeee888! - Remove NameNode override
#10218 140298a Thanks @eddeee888! - Drop Node 18 support

Patch Changes

Updated dependencies [140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a, 140298a]:
- @graphql-codegen/visitor-plugin-common@6.0.0
- @graphql-codegen/plugin-helpers@6.0.0
- @graphql-codegen/schema-ast@5.0.0

`v4.1.6`

Compare Source

Patch Changes

Updated dependencies [f6909d1]:
- @graphql-codegen/visitor-plugin-common@5.8.0

`v4.1.5`

Compare Source

Patch Changes

Updated dependencies [d8566c0]:
- @graphql-codegen/visitor-plugin-common@5.7.1

`v4.1.4`

Compare Source

Patch Changes

Updated dependencies [6d7c1d7]:
- @graphql-codegen/visitor-plugin-common@5.7.0

`v4.1.3`

Compare Source

Patch Changes

Updated dependencies [60dd72f]:
- @graphql-codegen/visitor-plugin-common@5.6.1

`v4.1.2`

Compare Source

Patch Changes

Updated dependencies [1617e3c, fa64fbf]:
- @graphql-codegen/visitor-plugin-common@5.6.0

`v4.1.1`

Compare Source

Patch Changes

Updated dependencies [55a1e9e, a235051]:
- @graphql-codegen/visitor-plugin-common@5.5.0
- @graphql-codegen/plugin-helpers@5.1.0

`v4.1.0`

Compare Source

Minor Changes

#10077 3f4f546 Thanks @eddeee888! - Extend config.avoidOptions to support query, mutation and subscription

Previously, config.avoidOptions.resolvers was being used to make query, mutation and subscription fields non-optional.
Now, config.avoidOptions.query, config.avoidOptions.mutation and config.avoidOptions.subscription can be used to target the respective types.

Patch Changes

Updated dependencies [3f4f546]:
- @graphql-codegen/visitor-plugin-common@5.4.0

`v4.0.9`

Compare Source

Patch Changes

Updated dependencies [79fee3c]:
- @graphql-codegen/visitor-plugin-common@5.3.1

`v4.0.8`

Compare Source

Patch Changes

Updated dependencies [808ada5, 14ce39e]:
- @graphql-codegen/visitor-plugin-common@5.3.0

`v4.0.7`

Compare Source

Patch Changes

Updated dependencies [dfc5310, 156cc2b, dfc5310, b49457b]:
- @graphql-codegen/plugin-helpers@5.0.4
- @graphql-codegen/visitor-plugin-common@5.2.0

`v4.0.6`

Compare Source

Patch Changes

Updated dependencies [920b443, ed9c205]:
- @graphql-codegen/visitor-plugin-common@5.1.0

`v4.0.5`

Compare Source

Patch Changes

Updated dependencies [53f270a]:
- @graphql-codegen/visitor-plugin-common@5.0.0

`v4.0.4`

Compare Source

Patch Changes

#9813 4e69568 Thanks @saihaj! - bumping for a release
Updated dependencies [4e69568]:
- @graphql-codegen/visitor-plugin-common@4.1.2
- @graphql-codegen/schema-ast@4.0.2
- @graphql-codegen/plugin-helpers@5.0.3

`v4.0.3`

Compare Source

Patch Changes

Updated dependencies [7718a8113]:
- @graphql-codegen/visitor-plugin-common@4.1.1

`v4.0.2`

Compare Source

Patch Changes

#9811 d8364e045 Thanks @saihaj! - dependencies updates:
- Updated dependency tslib@~2.6.0 ↗︎ (from ~2.5.0, in dependencies)
Updated dependencies [d8364e045, d8364e045, d8364e045, d8364e045, d8364e045]:
- @graphql-codegen/plugin-helpers@5.0.2
- @graphql-codegen/schema-ast@4.0.1
- @graphql-codegen/visitor-plugin-common@4.1.0

`v4.0.1`

Compare Source

Patch Changes

#9497 2276708d0 Thanks @eddeee888! - Revert default ID scalar input type to string

We changed the ID Scalar input type from string to string | number in the latest major version of typescript plugin. This causes issues for server plugins (e.g. typescript-resolvers) that depends on typescript plugin. This is because the scalar type needs to be manually inverted on setup which is confusing.
Updated dependencies [2276708d0]:
- @graphql-codegen/visitor-plugin-common@4.0.1

`v4.0.0`

Compare Source

Major Changes

#9375 ba84a3a27 Thanks @eddeee888! - Implement Scalars with input/output types

In GraphQL, Scalar types can be different for client and server. For example, given the native GraphQL ID:

A client may send string or number in the input
A client receives string in its selection set (i.e output)
A server receives string in the resolver (GraphQL parses string or number received from the client to string)
A server may return string or number (GraphQL serializes the value to string before sending it to the client )

Currently, we represent every Scalar with only one type. This is what codegen generates as base type:

export type Scalars = {
  ID: string
}

Then, this is used in both input and output type e.g.

export type Book = {
  __typename?: 'Book'
  id: Scalars['ID'] // Output's ID can be `string` 👍
}

export type QueryBookArgs = {
  id: Scalars['ID'] // Input's ID can be `string` or `number`. However, the type is only `string` here 👎
}

This PR extends each Scalar to have input and output:

export type Scalars = {
  ID: {
    input: string | number
    output: string
  }
}

Then, each input/output GraphQL type can correctly refer to the correct input/output scalar type:

export type Book = {
  __typename?: 'Book'
  id: Scalars['ID']['output'] // Output's ID can be `string` 👍
}

export type QueryBookArgs = {
  id: Scalars['ID']['input'] // Input's ID can be `string` or `number` 👍
}

Note that for typescript-resolvers, the type of ID needs to be inverted. However, the referenced types in GraphQL input/output types should still work correctly:

export type Scalars = {
  ID: {
    input: string;
    output: string | number;
  }
}

export type Book = {
  __typename?: "Book";
  id: Scalars["ID"]['output']; // Resolvers can return `string` or `number` in ID fields 👍
};

export type QueryBookArgs = {
  id: Scalars["ID"]['input']; // Resolvers receive `string` in ID fields 👍
};

export type ResolversTypes = {
  ID: ID: ResolverTypeWrapper<Scalars['ID']['output']>; // Resolvers can return `string` or `number` in ID fields 👍
}

export type ResolversParentTypes = {
  ID: Scalars['ID']['output']; // Resolvers receive `string` or `number` from parents 👍
};

Config changes:

Scalars option can now take input/output types:

config: {
  scalars: {
    ID: {
      input: 'string',
      output: 'string | number'
    }
  }
}

If a string is given (instead of an object with input/output fields), it will be used as both input and output types:

config: {
  scalars: {
    ID: 'string' // This means `string` will be used for both ID's input and output types
  }
}

BREAKING CHANGE: External module Scalar types need to be an object with input/output fields

config: {
  scalars: {
    ID: './path/to/scalar-module'
  }
}

If correctly, wired up, the following will be generated:

// Previously, imported `ID` type can be a primitive type, now it must be an object with input/output fields
import { ID } from './path/to/scalar-module'

export type Scalars = {
  ID: { input: ID['input']; output: ID['output'] }
}

BREAKING CHANGE: This changes Scalar types which could be referenced in other plugins. If you are a plugin maintainer and reference Scalar, please update your plugin to use the correct input/output types.

bb66c2a31 Thanks @n1ru4l! - Require Node.js >= 16. Drop support for Node.js 14

Minor Changes

#9196 3848a2b73 Thanks @beerose! - Add @defer directive support

When a query includes a deferred fragment field, the server will return a partial response with the non-deferred fields first, followed by the remaining fields once they have been resolved.

Once start using the @defer directive in your queries, the generated code will automatically include support for the directive.

// src/index.tsx
import { graphql } from './gql'
const OrdersFragment = graphql(`
  fragment OrdersFragment on User {
    orders {
      id
      total
    }
  }
`)
const GetUserQuery = graphql(`
  query GetUser($id: ID!) {
    user(id: $id) {
      id
      name
      ...OrdersFragment @&#8203;defer
    }
  }
`)

The generated type for GetUserQuery will have information that the fragment is incremental, meaning it may not be available right away.

// gql/graphql.ts
export type GetUserQuery = { __typename?: 'Query'; id: string; name: string } & ({
  __typename?: 'Query'
} & {
  ' $fragmentRefs'?: { OrdersFragment: Incremental<OrdersFragment> }
})

Apart from generating code that includes support for the @defer directive, the Codegen also exports a utility function called isFragmentReady. You can use it to conditionally render components based on whether the data for a deferred
fragment is available:

const OrdersList = (props: { data: FragmentType<typeof OrdersFragment> }) => {
  const data = useFragment(OrdersFragment, props.data);
  return (
    // render orders list
  )
};

function App() {
  const { data } = useQuery(GetUserQuery);
  return (
    {data && (
      <>
        {isFragmentReady(GetUserQuery, OrdersFragment, data)
					&& <OrdersList data={data} />}
      </>
    )}
  );
}
export default App;

#9304 e1dc75f3c Thanks @esfomeado! - Added support for disabling suffixes on Enums.

Patch Changes

Updated dependencies [4d9ea1a5a, 4d9ea1a5a, 4d9ea1a5a, f46803a8c, 3848a2b73, ba84a3a27, 63827fabe, 50471e651, 5aa95aa96, ca02ad172, e1dc75f3c, bb66c2a31, 5950f5a68, 5aa95aa96]:
- @graphql-codegen/plugin-helpers@5.0.0
- @graphql-codegen/schema-ast@4.0.0
- @graphql-codegen/visitor-plugin-common@4.0.0

`v3.0.4`

Compare Source

Patch Changes

Updated dependencies [386cf9044, 402cb8ac0]:
- @graphql-codegen/visitor-plugin-common@3.1.1

`v3.0.3`

Compare Source

Patch Changes

#9150 92d86b009 Thanks @rliljest! - Properly escape enum identifiers when enumsAsConst is used
Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:
- @graphql-codegen/visitor-plugin-common@3.1.0
- @graphql-codegen/plugin-helpers@4.2.0

`v3.0.2`

[Compare Source](https://redirect.github.com/dotansimha/graphql-code-generator/compare/a1edaee674bf118f4e3

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

changeset-bot · 2024-02-02T16:30:14Z

🦋 Changeset detected

Latest commit: 921c0ca

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@graphql-codegen/flow	Patch
@graphql-codegen/flow-operations	Patch
@graphql-codegen/flow-resolvers	Patch
@graphql-codegen/typescript-nest	Patch
@graphql-codegen/typescript-type-graphql	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

renovate Bot added the dependencies label Feb 2, 2024

renovate Bot requested review from dotansimha and saihaj February 2, 2024 16:30

amakhrov mentioned this pull request Oct 31, 2024

chore(deps): update @graphql-codegen dependencies #773

Open

12 tasks

renovate Bot force-pushed the renovate/major-graphql-codegen branch 3 times, most recently from 8b155c3 to 2d505a8 Compare December 15, 2024 00:06

renovate Bot force-pushed the renovate/major-graphql-codegen branch from 4ea3d5d to 2c914a2 Compare January 3, 2025 12:10

fix(deps): update graphql-codegen

84f0fa9

renovate Bot force-pushed the renovate/major-graphql-codegen branch from 6a3aa7d to 84f0fa9 Compare March 8, 2026 10:31

chore(dependencies): updated changesets for modified dependencies

921c0ca

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update graphql-codegen (major)#609

fix(deps): update graphql-codegen (major)#609
renovate[bot] wants to merge 2 commits into
mainfrom
renovate/major-graphql-codegen

renovate Bot commented Feb 2, 2024 •

edited

Loading

Uh oh!

changeset-bot Bot commented Feb 2, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

Conversation

renovate Bot commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

Patch Changes

Minor Changes

Major Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Major Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Major Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Major Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Major Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Configuration

Uh oh!

changeset-bot Bot commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

renovate Bot commented Feb 2, 2024 •

edited

Loading

changeset-bot Bot commented Feb 2, 2024 •

edited

Loading